Download and Configure Cycle
-
Download the domain binaries as mentioned in the Prerequisites section of this document.
-
The coherence version run on TomEE is Coherence CE 25.03.2. Ensure you to copy the latest following configuration files from Cycle distribution zip/conf directory into the externallibs/cycle_shared/conf directory under TomEE server( (This step is extremely important):
-
cycle-coherence-cache-config.xml
-
cycle-coherence-config.xml
-
Cycle.properties
-
logging.properties
-
dataIntake-spring-beans-true.xml
-
dataIntake-spring-beans-false.xml
-
cycle-spring-beans.xml
-
Update the oipa.url with the cycle application URL
Example: oipa.url=http://localhost:9090/PASJava
-
Identify the default locale in the Cycle.properties file. The locale selected will determine the translation that is loaded in the database for OIPA when it launches. The default setting is English.
application.defaultLocale
-
If using an Oracle or Microsoft SQL Server database, please skip this step. If using a DB2 database, you will need to modify the Cycle.properties file to include configuration for case-insensitive searching. Modify the Cycle.properties file to include the following line:
search.field.text.caseInsensitive=true
Under the lib folder of the externallibs/cycle_shared directory,
Copy the following files from the OIPA distribution zip/libs directory into the externallibs/cycle_shared/libs directory:
-
commons-collections4-4.5.0.jar
-
spring-instrument-6.2.17.jar
-
jakarta.persistence-api-3.2.0.jar
-
Download aspectj 1.9.1.jar from http://www.eclipse.org/downloads/download.php?file=/tools/aspectj/aspectj-1.9.1.jar.
-
Open aspectj-1.9.1.jar with an unzipping software and retrieve aspectjrt.jar and aspectjweaver.jar from the lib folder.
-
Copy aspectjrt.jar and aspectjweaver.jar into libs sub-directory.
-
Note: Rename all the jars without version names.
Example:
commons-collections4.jar
spring-instrument.jar
jakarta.persistence.jar
aspectj.jar
aspectjrt.jar
aspectjweaver.jar
-
-
To define the following environment variables at docker run time using the -e option in the command line or define them in the cycle_env.dat file.
Note: Refer to the System Properties document in the Oracle Insurance Policy Administration E62439-01 Documentation Library on the OTN for a complete list of all properties and allowed values.
The environment configuration variables, that need to be set for the TomEE server, and application configuration are defined below:
|
Configuration Parameters |
Variable |
|
CycleService Application Port |
CYCLE_PORT |
|
Server Port |
SERVER_PORT |
|
Application Redirect Port |
REDIRECT_PORT |
|
Enable AC |
ENABLE_AC |
|
JMX Port |
JMX_PORT |
|
Database Jar Used |
DBJar |
|
DataSource Configuration URL |
JDBCURL |
|
Database Username |
DSUSERNAME |
|
Database Password |
DSPASSWORD |
|
External Library Path |
EXT_LIB_PATH |
|
ATP Compatibility |
ATP_COMPLIANT |
Note: Refer to the cycle_env.dat file for more information regarding these variables.
-
CYCLE_PORT: Mention the CYCLE Application port
Example: CYCLE_PORT=7002
-
SERVER_PORT: Mention the Server Port
Example: SERVER_PORT=8001
-
REDIRECT_PORT: Mention the Application Redirect Port
Example: REDIRECT_PORT=7441
-
ENABLE_AC: This variable denotes whether the application is further connected to the Admin Console or not. Choose the appropriate option before provisioning the environment.
Example: ENABLE_AC=Yes
ENABLE_AC=No
-
JMX_PORT: Mention this port in order to expose JMX for remote connection.
Example: JMX_PORT=5555
-
DBJar: Based on the Database used for the application, mention the relevant jar
Example:
Oracle: DBJar=ojdbc.jar
DB2: DBJar=db2jcc4.jar
MSSQL: DBJar=mssql-jdbc.jar
-
JDBCURL: Mention the DataSource Configuration URL based on the database selected.
ORACLE: JDBCURL=jdbc:oracle:thin:@<host>:<port>:<sid>
DB2: JDBCURL=jdbc:db2://<host>:<port>/<databasename>:currentSchema=<schemaname>;
if the schema name and username are different, please append currentfunctionpath to above url.
Example:
jdbcDriver = com.ibm.db2.jcc.DB2Driver jdbcUrl = jdbc:db2://<host>:<port>/<databasename>:currentSchema= <schemaname>;currentFunctionPath=SYSIBM,SYSFUN,SYSPROC,SYSIBMADM,SYSHADOOP,USERNAME,SCHEMANAME;
MSSQL: JDBCURL=jdbc:sqlserver://<host>:<port>;DatabaseName=<databasename>
Example: For SQL Server
When the encrypt property is set to true and the trustServerCertificate property is set to true, the Microsoft JDBC Driver for SQL Server won't validate the SQL Server TLS certificate. This setting is common for allowing connections in test environments, such as where the SQL Server instance has only a self-signed certificate.
jdbcUrl = jdbc:sqlserver://<host>:<port>;DatabaseName=<databasename>;encrypt=true;trustServerCertificate=true
-
DSUSERNAME: Mention the username for the DataSource
-
DSPASSWORD: Mention the password for the DatabSource.
-
EXT_LIB_PATH: Define the Package Location inside the container (it is configured based on the base image used. No need to change the value of it)
Example: EXT_LIB_PATH=/usr/local/tomee/externallibs
-
ATP_COMPLIANT: This variable denotes whether the application is in compliance with ATP or not. Choose the appropriate option before provisioning the environment.
Example: ATP_COMPLIANT=Yes
If the CYCLE application is ATP compliant, then copy the required ATP (Autonomous Transaction Processing) database files under the externallibs/cycle_shared/atp directory.
The following parameters need to be updated in the cycle_env.dat file and the below jars need to be downloaded and copied to ojdbc folder.
Set Environment Variables - TomEE
-
For Windows deployment we need to create setenv.bat file in the bin folder of extracted TomEE directory.
-
For Linux deployment we need to create setenv.sh file in the bin folder of extracted TomEE directory.
The following configuration needs to be placed:
-
In the setenv.bat file for Windows environment:
Classpath
set CATALINA_OPTS=-Xms128m -Xmx1024m -XX:+UseG1GC
-Dtangosol.coherence.cacheconfig="C:/<Server Path>/shared/conf/coherence-cache-config.xml"
-Dtangosol.pof.config=com-adminserver-pas-web-pof-config.xml
-Dtangosol.coherence.override="C:/<Server Path>/shared/conf/coherence-config.xml"
-Dtangosol.coherence.distributed.localstorage=true
-Djava.naming.factory.initial=org.apache.activemq.jndi.ActiveMQInitialContextFactory
-Dtangosol.coherence.mode=prod
-Djava.util.logging.config.file="C:/<Server Path>/shared/conf/logging.properties"
-Dserver.name="<Name of the server>"
-
In the setenv.bat file for Linux environment:
ClassPath
export CATALINA_OPTS="-Xms128m -Xmx1024m -XX:+UseG1GC
-Dtangosol.coherence.cacheconfig=/Servers/TomEE/OIPAInstance/shared/conf/coherence-cache-config.xml
-Dtangosol.pof.config=com-adminserver-pas-web-pof-config.xml
-Dtangosol.coherence.override=/Servers/TomEE/OIPAInstance/shared/conf/coherence-config.xml
-Dtangosol.coherence.distributed.localstorage=true -Dtangosol.coherence.mode=prod
-Djava.util.logging.config.file=/Servers/TomEE/OIPAInstance/shared/conf/logging.properties
-Djava.naming.factory.initial=org.apache.activemq.jndi.ActiveMQInitialContextFactory
-Dserver.name=<Name of the server>"
Add Following dependent JARs for ATP
Following JDBC JAR files are required to have a successful database connection. The jars must be placed under:
/usr/local/tomee/externallibs/cycle_shared/atp/ojdbc directory
Note: Download the JAR files using this link
| JAR | Required? | Description |
|---|---|---|
| ojdbc.jar | Required | JDBC Thin Driver, please follow OIPA installation documentation for supported JDBC driver version |
| ons.jar | Optional | Only needed in case FAN (Fast Application Notification) is configured for Oracle RAC cluster |
| oraclepki.jar | Required | Oracle PKI (public key infrastructure) provider for Oracle Wallets |
| osdt_cert.jar | Required | Oracle Security Developer Tool Certificates |
| osdt_core.jar | Required | Oracle Security Developer Tool Core |
| ucp.jar | Required | Universal Connection Pool |
|
ATP Configuration Parameters |
Variables |
|
Wallet Location |
WALLET |
|
TNS DB name |
WALLETDB |
|
ATP Wallet Username |
WALLETUSERNAME |
|
ATP Wallet Password |
WALLETPASSWORD |
|
ATP Proxy |
ATP_PROXY |
|
ATP Proxy Port |
ATP_PROXY_PORT |
-
WALLET: Update the WALLET directory location ( which is preconfigured based on the container structure)
Example: WALLET=/usr/local/tomee/externallibs/cycle_shared/atp/wallet/
-
WALLETDB:- Open tnsnames.ora file (present in the wallet) and note the TNS name that is suffixed with _tp for transaction processing.
Example: WALLETDB=oipadb_tp
-
WALLETUSERNAME: Mention the username for the ATP connection
-
WALLETPASSWORD: Mention the password for the ATP connection
-
ATP_PROXY: The ATP instance is on Public IP, if connecting over VPN, then you need to use an HTTP: PROXY
Example: ATP_PROXY=www-proxy-hqdc.us.oracle.com
-
ATP_PROXY_PORT: Mention the HTTP: PROXY PORT
Example: ATP_PROXY_PORT=80
The sample folder structure is as follows:
-
Under ojdbc folder copy all the libs downloaded
-
Under wallet folder